groundsdk 7.7.2 API/com.parrot.drone.groundsdk.mavlink.standard/SetRoiCommand

SetRoiCommand

class SetRoiCommand(mode: SetRoiCommand.Mode, @IntRange(from = 0) waypointIndex: Int, @IntRange(from = 0) roiIndex: Int, pitchOrLatitude: Double, rollOrLongitude: Double, yawOrAltitude: Double, frame: MavlinkCommand.Frame = Frame.RELATIVE) : MavlinkCommand

MAVLink command which allows to set a Region Of Interest.

Parameters

mode

Region of interest mode.

waypointIndex

Waypoint index/ target ID (depends on mode).

roiIndex

Region of interest index. (allows a vehicle to manage multiple ROI's)

pitchOrLatitude

when mode is Mode.WAYPOINT_NEXT functions as the pitch offset from next waypoint, when Mode.LOCATION functions as latitude.

rollOrLongitude

when mode is Mode.WAYPOINT_NEXT it is ignored, when Mode.LOCATION functions as longitude. Roll is ignored by Anafi 2.

yawOrAltitude

when mode is Mode.WAYPOINT_NEXT functions as the yaw offset from next waypoint, when Mode.LOCATION functions as altitude.

frame

the reference frame of the coordinates.

Constructors

Link copied to clipboard
constructor(mode: SetRoiCommand.Mode, @IntRange(from = 0) waypointIndex: Int, @IntRange(from = 0) roiIndex: Int, pitchOrLatitude: Double, rollOrLongitude: Double, yawOrAltitude: Double, frame: MavlinkCommand.Frame = Frame.RELATIVE)

Types

Link copied to clipboard
object Companion
Link copied to clipboard
enum Mode : Enum<SetRoiCommand.Mode>

ROI mode.

Properties

Link copied to clipboard
Link copied to clipboard
val frame: MavlinkCommand.Frame

The coordinate frame; set to global coordinate frame or relative altitude over ground.

Link copied to clipboard
val mode: SetRoiCommand.Mode

ROI mode

Link copied to clipboard
val parameters: DoubleArray

the raw parameters of the command

Link copied to clipboard
val pitchOrLatitude: Double

When mode is Mode.WAYPOINT_NEXT then it is the pitch offset from next waypoint, when Mode.LOCATION then it is the latitude.

Link copied to clipboard
val rawType: Int

The MAVLink command type

Link copied to clipboard
val roiIndex: Int

ROI index

Link copied to clipboard
val rollOrLongitude: Double

When mode is Mode.WAYPOINT_NEXT it is ignored, when Mode.LOCATION then it is the longitude.

Link copied to clipboard
val waypointIndex: Int

Waypoint index/ target ID

Link copied to clipboard
val yawOrAltitude: Double

When mode is Mode.WAYPOINT_NEXT then it is the yaw offset from next waypoint, when Mode.LOCATION then it is the altitude.

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
fun write(writer: Writer, index: Int, frame: MavlinkCommand.Frame)

Writes the MAVLink command to the given writer.